What was changed

Makefile

Changes:

• Implemented Docker-based command encapsulation to streamline local development setups.
• Simplified environment management and application operations through Docker Compose.

Rationale:

• Provides a single point of entry to execute common commands, improving developer experience by standardizing project setup.
• Facilitates the use of Docker to handle various PHP versions and essential development tools without local installation, promoting environment consistency. This includes managing dependencies and tools such as:
  • Actionlint: Helps in linting and validating GitHub Actions workflows to ensure they are error-free.
  • Yamllint: Ensures YAML files are syntactically correct and adhere to best practices.
  • Envsubst: A tool for substituting environment variables in shell formats.
  • Markdownlint: Assists in maintaining consistent markdown formatting according to defined rules.
  • Phive: A PHAR manager that simplifies installing and managing PHP tools distributed as PHAR files.
  • PHAR build: Builds PHP applications into a single PHAR (PHP Archive) file for easy distribution and deployment.
  • Composer dependency management: Manages PHP package dependencies, ensuring the project has all required libraries with specified versions.
• Supports multi-architecture PHP Docker images: arm64 and amd64, ensuring compatibility across different development setups (MacOS, Linux) and minimizing configuration overhead.

.env and .env.example

Changes:

• Introduced .env and .env.example files to better control Docker composition and debugging capabilities in local development environment.

Rationale:

• Allows precise control over the Docker environment, aiding in project organization and debugging processes.
• Enhances the reproducibility of bugs and testing scenarios across different environments, enabling developers to identify and address issues more quickly and easily without relying on GitHub Actions.

box.json.dist

Changes:

• Configured settings for the Box application bundler to specify compaction, file inclusion, and output settings for building PHAR files.

Rationale:

• Facilitates the packaging of the application into a single PHAR file, simplifying deployment and distribution. This allows developers to install the package as a PHAR archive using PHIVE, avoiding the need to include buggregator/trap as a dev composer dependency and preventing bloat in development requirements.
• Closes Build PHAR #20

composer.json

Changes:

• Standardized the formatting of the composer.json file using the composer-normalize tool.

Rationale

• Enhances the maintainability and clarity of the composer.json file by ensuring it adheres to consistent formatting guidelines.

docker-compose.yaml

Changes:

• • Integrated the wayofdev/php-dev Docker image to provide developers with a ready-to-use solution, eliminating the need to install PHP and its extensions locally.

Rationale:

• Enables quick switching between different PHP environments, enhancing testing across versions. This flexibility is supported by the availability of multiple tags, which can be found here:

  • 8.3-cli-alpine-latest
  • 8.2-cli-alpine-latest
  • 8.1-cli-alpine-latest

  These images are packaged as multi-arch, supporting both ARM architectures (suitable for macOS M1, M2, M3 series) and AMD64 (compatible with Intel and AMD x86-64 processors). This ensures a seamless development experience across various hardware platforms.

• wayofdev/php-dev Docker images come equipped with built-in development tools and XDebug support, significantly reducing the setup time for developers. This integration enhances productivity and ensures a seamless integration with IDEs like PHPStorm, optimizing the development process.

phpunit.xml

Changes:

• Updated PHPUnit configuration to centralize cache results and adjust execution settings, by using one single folder, for all development tools .build